feat(docs-platform): Beta banner#5259
Open
lena-larionova wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
7e7c799 to
3b34a9c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR automates stage warning banners for beta and tech preview docs pages, replacing manual beta callouts on conditional plugin execution docs.
Changes:
- Adds a reusable stage banner include.
- Renders the banner from the shared main layout when
betaortech_previewis set. - Removes manual beta warning callouts from two Gateway docs pages.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
app/_includes/banners/stage.html |
Adds the reusable beta/tech preview warning banner. |
app/_includes/layouts/main.html |
Renders the stage banner in the shared main page layout. |
app/gateway/plugins/expressions.md |
Removes the manual beta warning now intended to be automated. |
app/_how-tos/gateway/configure-conditional-plugin-execution.md |
Removes the manual beta warning now intended to be automated. |
Comment on lines
+55
to
+57
| {%- if page.beta == true or page.tech_preview == true -%} | ||
| {%- include_cached banners/stage.html beta=page.beta tech_preview=page.tech_preview -%} | ||
| {%- endif -%} |
Comment on lines
+55
to
+57
| {%- if page.beta == true or page.tech_preview == true -%} | ||
| {%- include_cached banners/stage.html beta=page.beta tech_preview=page.tech_preview -%} | ||
| {%- endif -%} |
Contributor
Author
There was a problem hiding this comment.
That's fine. The beta warning is in the metadata already, so the LLM will have that information. This change is specifically for human eyes that aren't noticing the badge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PM recently manually added banners to beta docs pages because they couldn't see the "beta" badge on those pages. I'm making this into an automated change - if
beta:trueortech_preview:true, the banner will appear.I'm not sure how I feel about this; it feels like overkill, now that I've added these banners. Is there a better way to display the information?
Example preview pages:
https://deploy-preview-5259--kongdeveloper.netlify.app/kongctl/get-started/
https://deploy-preview-5259--kongdeveloper.netlify.app/kongctl/adopt/